cs-salesforce-sapi

This section describes the attributes and usage of the cs-salesforce-sapi API Service.

💂️ Base Information

• API Title: cs-salesforce-sapi
• Version: 1.0.0
• Base URL: https://cs-salesforce-sapi-{env}-v1.us-e1.cloudhub.io/api/Replace {env} with:
  • dev (Development)
  • qa (Quality Assurance)
  • prod (Production)

🔑 Authentication

The API implements two security schemes:

1. client-id-enforcement
2. OAuth2

Required Headers

• client_id
  • Length: 32 - 36 characters
  • Example: 123e4567-e89b-12d3-a456-426614174000
• Authorization
  • Format: Bearer token
  • Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

📌 These headers are required in all requests.

📊 Common Headers

Most endpoints in this API require the following standard request headers:

Specific endpoints may require additional headers. Refer to the detailed endpoint documentation for specific requirements.

📑 Request & Response Format

Request Format

The API supports the following request formats:

• application/json - For JSON payloads
• application/octet-stream - For binary file uploads

Response Format

The API primarily returns responses in:

• application/json - For structured data responses
• application/octet-stream - For file downloads

Each response includes appropriate HTTP status codes and headers.

📁 API Structure Overview

This API is organized into several functional areas:

1. Work Orders - Management of work orders for services
2. File Services - File storage and retrieval services
3. Customer Management - Customer information handling
4. IVR Integration - Interactive Voice Response system integration
5. Document Management - File attachment and consultation
6. PQR Handling - Petition, Complaint, and Claim management
7. Claims Processing - Claims filing and reporting
8. Appointment Scheduling - Management of appointments
9. Case Management - Salesforce case operations
10. Habeas Data - Personal data processing authorizations
11. Senda Integration - Operations for Senda system

For detailed information on each endpoint, including request/response formats and parameters, refer to the specific endpoint documentation.

🔐 Security Schemes

Client ID Enforcement

OAuth2

The API uses both client_id-enforcement and OAuth2 as security schemes. All requests must include both a valid client_id and OAuth2 Bearer token in the request headers.

⚠️ Error Codes

All API endpoints implement common HTTP error code handling as defined in the API specification.

📚 Endpoint Documentation Example

/claims

Filing indemnities in Salesforce.

• URL: https://cs-salesforce-sapi-{env}-v1.us-e1.cloudhub.io/api/claims
• Method: POST
• Authentication: client_id and OAuth2
• Required Headers:
  • Content-Type: application/json
  • Accept: application/json
  • client_id: [your-client-id]
  • Authorization: Bearer [your-token]

Request Example:

bash

curl -X POST \

https://cs-salesforce-sapi-prod-v1.us-e1.cloudhub.io/api/claims \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H 'client_id: 123e4567-e89b-12d3-a456-426614174000' \

-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \

-d '{

"claimId": "CL-12345",

"policyNumber": "POL-67890",

"claimDate": "2025-05-01",

"claimType": "Accident",

"description": "Vehicle collision at intersection",

"claimAmount": 5000.00,

"claimantInfo": {

"documentType": 1,

"documentNumber": "79533115",

"name": "John Doe",

"contactNumber": "+573102345678"

}

}'

Response Example:

json

{

"status": "success",

"data": {

"claimReference": "REF-CL-98765",

"submissionDate": "2025-05-13T16:20:10Z",

"estimatedResponseTime": "48 hours",

"trackingUrl": "https://claims.colmena.com/track/REF-CL-98765"

}

}

📌 Note: This is just one example endpoint. The API contains multiple endpoints as listed in the API Structure Overview section. For detailed information about other endpoints, please refer to the complete API documentation.

📞 Support

For assistance, contact the Integration Services and Applications Coordination team.

📧 epalma@fgs.co

Last updated: May 2025